Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add helm starter chart for developing helm chart #967

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

lianhao
Copy link
Collaborator

@lianhao lianhao commented Dec 3, 2024

Description

Helm starter chart pack can be used to create helm chart for new services.

Issues

n/a.

Type of change

List the type of change like below. Please delete options that are not relevant.

  • Others (enhancement, documentation, validation, etc.)

Dependencies

List the newly introduced 3rd party dependency if exists.

Tests

Describe the tests that you ran to verify your changes.

@lianhao lianhao force-pushed the helm-chart-starter branch from a8ed171 to bc37842 Compare December 3, 2024 08:03
@lianhao
Copy link
Collaborator Author

lianhao commented Dec 3, 2024

Let's hold this until we've got the helm charts directory layout figured out

@lianhao lianhao force-pushed the helm-chart-starter branch from bc37842 to fe34c8c Compare December 4, 2024 06:29
Copy link
Contributor

@eero-t eero-t left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think some instructions on using the template are also needed.

It could e.g. state which classes service needs to use, for it to have v1/health_check endpoint for the probes, and that services always need to handle SIGTERM, to avoid lost requests on service scale down.

dev/helm-chart-starter/templates/tests/test-pod.yaml Outdated Show resolved Hide resolved
dev/helm-chart-starter/values.yaml Outdated Show resolved Hide resolved
dev/helm-chart-starter/values.yaml Outdated Show resolved Hide resolved
dev/helm-chart-starter/values.yaml Outdated Show resolved Hide resolved
dev/helm-chart-starter/values.yaml Outdated Show resolved Hide resolved
dev/helm-chart-starter/values.yaml Outdated Show resolved Hide resolved
dev/helm-chart-starter/templates/_helpers.tpl Outdated Show resolved Hide resolved
Comment on lines +25 to +29
## Values

| Key | Type | Default | Description |
| ------------------------------- | ------ | ------------------------------------ | ---------------------- |
| global.HUGGINGFACEHUB_API_TOKEN | string | `insert-your-huggingface-token-here` | Hugging Face API token |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this needs a link to a shared documentation explaining all the common keys in the values file (proxies etc). Such doc could be split to sections based on how commonly given keys need to be specified by the user.

dev/helm-chart-starter/values.yaml Outdated Show resolved Hide resolved
@lianhao lianhao force-pushed the helm-chart-starter branch from fe34c8c to fca6e49 Compare January 6, 2025 01:38
Helm starter chart pack can be used to create helm chart for new
services.

Signed-off-by: Lianhao Lu <[email protected]>
@lianhao lianhao force-pushed the helm-chart-starter branch from fca6e49 to 6a14f40 Compare January 6, 2025 01:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants